Interface DHCPClientProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
DHCPClientProcessImpl

public interface DHCPClientProcess extends Process
Information provided by the PKI file:

    \class DhcpClientProcess
    
    \brief DhcpClientProcess handles the DHCP client process.
    
    \example network().getDevice("Router0").getProcess("DhcpClient")
    
Author:
Auto-generated
  • Method Details

    • removePortDataEntry

      void removePortDataEntry(String portName)
      Information provided by the PKI file:
      
          \brief Runs DHCP on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Parameters:
      portName - Takes in a parameter of portName
    • addPortDataEntry

      void addPortDataEntry(String portName)
      Parameters:
      portName - Takes in a parameter of portName
    • isPortExisted

      boolean isPortExisted(String portName)
      Information provided by the PKI file:
      
          \brief Runs DHCP on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • dhcpRun

      void dhcpRun(String portName)
      Information provided by the PKI file:
      
          \brief Start dhcp process on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Parameters:
      portName - Takes in a parameter of portName
    • dhcpRelease

      boolean dhcpRelease(String portName)
      Information provided by the PKI file:
      
          \brief Releases the DHCP lease from the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • resetDhcpConfOn

      boolean resetDhcpConfOn(String portName)
      Information provided by the PKI file:
      
          \brief Resets the DHCP configuration on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • getDataOfPort

      DHCPClientPortData getDataOfPort(String portName)
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      DHCPClientPortData Returns a DHCPClientPortData